-
Notifications
You must be signed in to change notification settings - Fork 769
VC reorganization #10607
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: development
Are you sure you want to change the base?
VC reorganization #10607
Conversation
| --- | ||
| title: "Working with Git On-Premises Version Control Server" | ||
| linktitle: "Git On-Premises Version Control Server" | ||
| title: "Optional: Working with Private Git" |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This topic has a lot of info about set up and configuration. Consider either splitting it up (enabling / configuring) or moving the whole thing into its own separate top-level topic (where?)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
From my perspective the Optional: Working with Private Git as child of Configuring Version Control is fine. People will find it here, and having the information bundled is probably preferable over splitting it.
| @@ -0,0 +1,29 @@ | |||
| --- | |||
| title: "Peer Reviewing Changes" | |||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
might need to rename this to Using History and include also troubleshooting as a use case.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
In the 11.9 or 11.10 release more content will be added related to 'inspecting history' which is very important for reviewing, but still a more generic name about History is probably preferable.
| description: "Describes how to work with version control and how to resolve some issues which may arise." | ||
| --- | ||
|
|
||
| ## Introduction |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
| description: "Describes how to work external tools to deploy packages." | ||
| --- | ||
|
|
||
| ## Introduction |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
|
Should also add linking to these topics back from https://docs.mendix.com/refguide/version-control-menu/ and its subpages as needed. |
| linktitle: "Using Version Control" | ||
| weight: 10 | ||
| weight: 50 | ||
| description: "Describes how to work with version control and how to resolve some issues which may arise." |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Troubleshooting is no longer a part, or a child, of this Using version control page.
| ## Read More | ||
|
|
||
| * [Advanced Branching and Merging Strategies](https://www.mendix.com/blog/advanced-branching-merging-strategies-part-1-2/) | ||
| For more information on how version control works in Mendix, see [Version Control](/refguide/version-control/). No newline at end of file |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This page now basically contains these two sentences, that seem contradictory 😅
This document describes how to use version control in Mendix Studio Pro.
For more information on how version control works in Mendix, see [Version Control].
| @@ -0,0 +1,80 @@ | |||
| --- | |||
| title: "Deploying Packages with External Tools" | |||
| url: /refguide/using-version-control-in-studio-pro/ | |||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This URL is incorrect so the page doesn't open correctly when running the Docs site.
| @@ -0,0 +1,80 @@ | |||
| --- | |||
| title: "Deploying Packages with External Tools" | |||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
When reading the contents of this page, it seems to be about working with External Tools in general; not related to deploying?
|
|
||
| With more complex apps, you may want to manage your code in a more sophisticated way. For example, you may want to develop new features separately from the currently deployed version of your app so that you can fix any bugs without having to release all the new features. This is done using [Branch Lines](#branch-line). | ||
|
|
||
| If you are already familiar with using branches, you can check the [Branching Best-Practices](/refguide/using-version-control-in-studio-pro/#branching-best-practices) section of *Using Version Control in Studio Pro* for advice on how to use branches when developing your Mendix app. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Link is incorrect.
| url: /refguide/peer-reviewing/ | ||
| linktitle: "Peer Reviewing" | ||
| weight: 60 | ||
| description: "Describes how to work with version control and how to resolve some issues which may arise." |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Description is not correct.
|
|
||
| Select a revision to see additional details, such as related stories, changed documents, Studio Pro version, and changes on disk. Icons summarize the kinds of changes that happened in the app. | ||
|
|
||
| {{< figure src="/attachments/refguide/version-control/using-version-control-in-studio-pro/history-of-dialog.png" class="no-border" >}} No newline at end of file |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Suggest to replace this image with the one on https://docs.mendix.com/refguide/history-dialog/.
| @@ -0,0 +1,163 @@ | |||
| --- | |||
| title: "Pushing, Pulling, and Comitting" | |||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The normal order would be 'Pulling' (before you start working), 'Committing' and then 'Pushing'. Perhaps it make sense to reorder the title and description to accommodate for that.
| description: "Describes how to push, pull, and commit your changes." | ||
| --- | ||
|
|
||
| ## Introduction |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This chapter is not correct? Seems to be copied from another page.
| @@ -1,8 +1,7 @@ | |||
| --- | |||
| title: "Troubleshooting Version Control" | |||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
For several pages (like "Using version control") we now have a basically empty page, with subpages.
For this troubleshooting page however, we have a full page, with two subpages. Is this something you'd want to make consistent?
|
|
||
| Mendix Studio Pro needs to connect to the Team Server, where all your apps are stored. If you are having issues connecting to the Team Server, see [Troubleshooting Team Server Issues](/refguide/troubleshoot-team-server-issues/). | ||
|
|
||
| ### Getting an Unexpected Error: `The project contains changes that have not been committed yet. Please commit first before attempting to merge again.` {#css-error} |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The formatting of this is ugly, and it has been bothering me for years. Do you have an idea how to improve this?
| Version control in Mendix is built on top [Git](https://git-scm.com). The concepts will be familiar to seasoned users of these version control systems (VCS). Mendix simplifies the VCS commands by building them into Studio Pro and the Mendix Portal. | ||
|
|
||
| ## Concepts {#concepts} | ||
| ### Mendix Team Server |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think the structure within this page should be revised a bit. Most questions are 'server-related' but the PR chapter 5 isn't really related. And then chapter 6 is an overall 'documents in this category' section.
| @@ -0,0 +1,41 @@ | |||
| --- | |||
| title: "Enabling Version Control for Your App" | |||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm not sure if this deserves to be a top-level page within the VC section. Perhaps we can move it down to the Configuring section?
No description provided.